Samples in Project Console
Data sets A collection of related information that can be used in templates and flows. define the fields The Open Data Protocol (OData) is a data access protocol built on core protocols like HTTP and commonly accepted methodologies like REST for the web. There are various kinds of libraries and tools can be used to consume OData services. mapped into templates. While creating and viewing Samples is still available in the Samples tab in Data Sets, users can also create a quick preview directly in the Data Sets Builder. These quick Previews allow designers to preview the data pulled based on the fields and entities they select and can be saved for future use.
Create a Sample
Creating a Sample within a data set is a crucial step in the design phase of Smart Flows. It offers a preview of how data is structured and will appear in your final documents. This process not only facilitates a better understanding of the data's practical application, but it also enables designers to refine and optimize the data set to meet specific requirements.
There are three different types of Samples you can create in Smart Flows, XML and JSON, Smart Forms, and Schema.
1. | Select the Data sets button. |
The Data sets page displays.
2. | In the Data set List view, select a Data Set. |
3. | Select Samples. |
4. | Select the +Create button. |
5. | In the Name field, enter a name for the Sample. |
6. | (Optional) In the Description field, enter a description for the Sample. |
Once you reach the Create a Sample dialog, you have two options on how to proceed.
You can upload a sample file via the File Explorer browser and upload the sample file before you begin editing it, see Upload and Edit a Schema Method.
You can type or paste your sample data via the Edit tab, edit the sample and upload the edited Sample, see Edit and Create a Sample Method.
Upload and Edit a Schema Method
1. | Select Browse and select your schema file in the File Explorer. |
If you are using the upload and edit schema method, you can't switch to the Edit tab to make changes before saving. If you make edits and switch back to the Sample file tab, the edited file no longer matches the file you've selected in the File Explorer and therefore does not display.
2. | Select Create. |
Your Sample displays in the List view.
3. | In the List view, select your Sample. |
The Edit sample tab displays.
4. | In the Edit tab, make any required changes to your Sample. |
You can use Pretty print to make the XML easier to read. It restructures the spacing and indentation of the data to make hierarchy clearer.
5. | Select Save. |
The changes to your Sample are saved.
Edit and Create a Sample Method
1. | Select the Edit tab. |
2. | In the Edit tab, type or paste your data. |
3. | Select Save. |
The edited Sample displays in the List view.
1. | Select the Data sets button. |
The Data sets page displays.
2. | In the Data set List view, select a Data Set. |
3. | Select Samples. |
4. | Select the +Create button. |
5. | In the Name field, enter a name for the Sample. |
6. | (Optional) In the Description field, enter a description for the Sample. |
7. | (Optional) In the Comment field, enter a comment for the Sample. |
8. | Select Create. |
Schema data set samples support multi-level filters that allow you to differentiate between samples with similarities by presenting them both to you simultaneously. You can then drill down an additional level, see the example below for more details.
Primary Filter:
Imagine you’re looking for a client in the dropdown menu. You can now select a search property such as the client's Display Name or Internal View.
Start typing the client’s name, and the dropdown continuously update to show relevant matches. If there are clients with similar names, they will be differentiated by additional details like an ID number displayed in light grey.
Example: You type A. Datum Corp. and immediately see:
-
A. Datum Corp. - 1234567890 (grey text)
-
A. Datum Corp. - 1234567891 (grey text)
Secondary Filter:
To filter down further, set a secondary filter based on another property, such as the city where the client is located, and choose how you want the results to match (like “Contains” or “Equals”).
Now, when you type in the city name alongside the client's name, the dropdown will refine the list even more, displaying both the city and the ID in grey to keep your results clear and organized.
Example: You've already set the primary filter to A. Datum Corp. and add a secondary filter for the city Boston:
-
A. Datum Corp. - Boston - 1234567890 (all grey text)
-
A. Datum Corp. - Boston - 1234567891 (all grey text)
Text Formatting in Results:
First Filter Applied: Bold text for the primary search term with any identifiers in grey to help you spot differences at a glance.
Second Filter Applied: Continued bold text for the primary search term, with secondary filter details and identifiers in grey for additional clarity.
Empty Filter Behavior:
If you do not use keywords in the primary filter, you can scroll through the complete list as usual.
If you only use the secondary filter, the dropdown adjusts to filter based on this secondary criteria alone, simplifying your search when you know exactly what detail you’re looking for.
1. | Select the Data sets button. |
The Data sets page displays.
2. | In the Data set List view, select a Data Set. |
3. | Select Samples. |
4. | Select the +Create button. |
5. | In the Name field, enter a name for the Sample, or select the filter icon. |
Selecting the filter icon expands the Reference field, and you see the multi-level filters for drop-downs.
6. | From the Reference field's dropdown menu pick a property to filter by. |
7. | Determine if you want to search for the property type with words that are directly equivalent to the property type (Equal), or with words that are similar to (Like). |
In this example, we have chosen Like.
8. | Type a word or phrase that is similar to what you are looking for. |
In our example, we have entered the word Assembly.
9. | From the filter icon dropdown menu, select the property. |
In our example, we have chosen Litware Assembly.
Notice that the name we chose as our Reference by default also becomes the Name of the sample. If you choose to you can also change the name.
10. | Select Create. |
The Sample is created and is listed under the account.
Configure a Preview
1. | Select the Data sets button. |
The Data sets page displays.
4. | Select the N:1 Relations button. |
On the right, the N:1 RELATIONS display.
5. | Select the N:1 RELATIONSto use in your preview. |
A (1) displays next to N:1 RELATIONS.
6. | Select the 1:N RELATIONS button. |
On the right, the 1:N RELATIONS display.
7. | Select the 1:N RELATIONSto use in your preview. |
A (1) displays next to 1:N RELATIONS.
Under 1:N RELATIONS, the 1:N relation selected displays.
Generate Sample Preview
8. | In the top right, select the Preview sample button. |
The dropdown menu displays.
9. | Select the Sample to generate. |